Updates an existing address
Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.
- application/json
Request Body array required
- bpna string required
A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.
- name string
The name of the address. This is not according to official registers but according to the name the sharing member chooses.
states object[] required
The list of (temporary) states of the address.
validFrom date-timeThe date from which the state is valid.
validTo date-timeThe date until the state is valid.
type string requiredPossible values: [
ACTIVE
,INACTIVE
]One of the state types: active, inactive.
identifiers object[] required
The list of identifiers of the address.
value string requiredThe value of the identifier like "0847976000005".
type string requiredThe type of the identifier.
physicalPostalAddress object required
A physical postal address describes the physical location of an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude float requiredLongitude coordinate
latitude float requiredLatitude coordinate
altitude floatAltitude, if applicable
country string requiredPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city string requiredThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway
name stringThe name of the street.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
alternativePostalAddress object
An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude float requiredLongitude coordinate
latitude float requiredLatitude coordinate
altitude floatAltitude, if applicable
country string requiredPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]The 2-digit country code of the physical postal address according to ISO 3166-1.
administrativeAreaLevel1 stringThe 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city string requiredThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType string requiredPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber string requiredThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
confidenceCriteria object required
sharedByOwner boolean requiredcheckedByExternalDataSource boolean requirednumberOfSharingMembers int32 requiredlastConfidenceCheckAt date-time requirednextConfidenceCheckAt date-time requiredconfidenceLevel int32 required- requestKey string required
- 200
- 400
The successfully updated records, possible errors are returned
- application/json
- Schema
- Example (from schema)
Schema
entities object[]
bpna stringA BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.
name stringThe name of the address. This is not according to official registers but according to the name the sharing member chooses.
states object[]
The list of (temporary) states of the address.
validFrom date-timeThe date from which the state is valid.
validTo date-timeThe date until the state is valid.
type object
Named type uniquely identified by its technical key
technicalKey stringPossible values: [
ACTIVE
,INACTIVE
]Unique key of this type for reference
name stringName or denotation of this type
identifiers object[]
The list of identifiers of the address.
value stringThe value of the identifier like "0847976000005".
type object
Named type uniquely identified by its technical key
technicalKey stringUnique key of this type for reference
name stringName or denotation of this type
physicalPostalAddress object
A physical postal address describes the physical location of an office, warehouse, gate, etc.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country object
Named type uniquely identified by its technical key
technicalKey stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]Unique key of this type for reference
name stringName or denotation of this type
administrativeAreaLevel1 object
Region within a country
countryCode stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]Country code
regionCode stringAbbreviation or shorthand of the area
regionName stringDescribes the full name of the region within a country according to ISO 3166-214
administrativeAreaLevel2 stringThe name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
administrativeAreaLevel3 stringThe name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
district stringThe name of the district of the physical postal address which divides the city in several smaller areas.
street object
The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway
name stringThe name of the street.
houseNumber stringThe number representing the exact location of a building within the street.
houseNumberSupplement stringmilestone stringThe number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
direction stringThe cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
namePrefix stringThe street related information, which is usually printed before the official street name on an address label.
additionalNamePrefix stringThe additional street related information, which is usually printed before the official street name on an address label.
nameSuffix stringThe street related information, which is usually printed after the official street name on an address label.
additionalNameSuffix stringThe additional street related information, which is usually printed after the official street name on an address label.
companyPostalCode stringThe company postal code of the physical postal address, which is sometimes required for large companies.
industrialZone stringThe industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.
building stringThe alphanumeric identifier of the building addressed by the physical postal address.
floor stringThe number of a floor in the building addressed by the physical postal address, synonym: level.
door stringThe number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.
alternativePostalAddress object
An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
geographicCoordinates object
The exact location of the physical postal address in latitude, longitude, and altitude.
longitude floatLongitude coordinate
latitude floatLatitude coordinate
altitude floatAltitude, if applicable
country object
Named type uniquely identified by its technical key
technicalKey stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]Unique key of this type for reference
name stringName or denotation of this type
administrativeAreaLevel1 object
Region within a country
countryCode stringPossible values: [
UNDEFINED
,AC
,AD
,AE
,AF
,AG
,AI
,AL
,AM
,AN
,AO
,AQ
,AR
,AS
,AT
,AU
,AW
,AX
,AZ
,BA
,BB
,BD
,BE
,BF
,BG
,BH
,BI
,BJ
,BL
,BM
,BN
,BO
,BQ
,BR
,BS
,BT
,BU
,BV
,BW
,BY
,BZ
,CA
,CC
,CD
,CF
,CG
,CH
,CI
,CK
,CL
,CM
,CN
,CO
,CP
,CR
,CS
,CU
,CV
,CW
,CX
,CY
,CZ
,DE
,DG
,DJ
,DK
,DM
,DO
,DZ
,EA
,EC
,EE
,EG
,EH
,ER
,ES
,ET
,EU
,EZ
,FI
,FJ
,FK
,FM
,FO
,FR
,FX
,GA
,GB
,GD
,GE
,GF
,GG
,GH
,GI
,GL
,GM
,GN
,GP
,GQ
,GR
,GS
,GT
,GU
,GW
,GY
,HK
,HM
,HN
,HR
,HT
,HU
,IC
,ID
,IE
,IL
,IM
,IN
,IO
,IQ
,IR
,IS
,IT
,JE
,JM
,JO
,JP
,KE
,KG
,KH
,KI
,KM
,KN
,KP
,KR
,KW
,KY
,KZ
,LA
,LB
,LC
,LI
,LK
,LR
,LS
,LT
,LU
,LV
,LY
,MA
,MC
,MD
,ME
,MF
,MG
,MH
,MK
,ML
,MM
,MN
,MO
,MP
,MQ
,MR
,MS
,MT
,MU
,MV
,MW
,MX
,MY
,MZ
,NA
,NC
,NE
,NF
,NG
,NI
,NL
,NO
,NP
,NR
,NT
,NU
,NZ
,OM
,PA
,PE
,PF
,PG
,PH
,PK
,PL
,PM
,PN
,PR
,PS
,PT
,PW
,PY
,QA
,RE
,RO
,RS
,RU
,RW
,SA
,SB
,SC
,SD
,SE
,SF
,SG
,SH
,SI
,SJ
,SK
,SL
,SM
,SN
,SO
,SR
,SS
,ST
,SU
,SV
,SX
,SY
,SZ
,TA
,TC
,TD
,TF
,TG
,TH
,TJ
,TK
,TL
,TM
,TN
,TO
,TP
,TR
,TT
,TV
,TW
,TZ
,UA
,UG
,UK
,UM
,US
,UY
,UZ
,VA
,VC
,VE
,VG
,VI
,VN
,VU
,WF
,WS
,XI
,XU
,XK
,YE
,YT
,YU
,ZA
,ZM
,ZR
,ZW
]Country code
regionCode stringAbbreviation or shorthand of the area
regionName stringDescribes the full name of the region within a country according to ISO 3166-214
postalCode stringThe alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city stringThe name of the city of the physical postal address, synonyms: town, village, municipality.
deliveryServiceType stringPossible values: [
PO_BOX
,PRIVATE_BAG
,BOITE_POSTALE
]One of the alternative postal address types: P.O. box, private bag, boite postale.
deliveryServiceQualifier stringThe qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber stringThe number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
bpnLegalEntity stringThe BPNL of the legal entity owning the address.
bpnSite stringThe BPNS of the site the address belongs to.
isCatenaXMemberData booleanIndicates whether the address is owned and thus provided by a Catena-X Member.
createdAt date-timeThe date when the data record has been created.
updatedAt date-timeThe date when the data record has been last updated.
confidenceCriteria object
sharedByOwner booleancheckedByExternalDataSource booleannumberOfSharingMembers int32lastConfidenceCheckAt date-timenextConfidenceCheckAt date-timeconfidenceLevel int32addressType stringPossible values: [
LegalAndSiteMainAddress
,LegalAddress
,SiteMainAddress
,AdditionalAddress
]Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.
errors object[]
errorCode stringPossible values: [
AddressNotFound
,RegionNotFound
,IdentifierNotFound
,AddressDuplicateIdentifier
]AddressUpdateError
message stringError message that explains the error
entityKey stringKey of the entity that failed from the request object: index or BPN
- entityCount int32
- errorCount int32
{
"entities": [
{
"bpna": "string",
"name": "string",
"states": [
{
"validFrom": "2024-05-15",
"validTo": "2024-05-15",
"type": {
"technicalKey": "ACTIVE",
"name": "string"
}
}
],
"identifiers": [
{
"value": "string",
"type": {
"technicalKey": "string",
"name": "string"
}
}
],
"physicalPostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": {
"technicalKey": "UNDEFINED",
"name": "string"
},
"administrativeAreaLevel1": {
"countryCode": "UNDEFINED",
"regionCode": "string",
"regionName": "string"
},
"administrativeAreaLevel2": "string",
"administrativeAreaLevel3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"street": {
"name": "string",
"houseNumber": "string",
"houseNumberSupplement": "string",
"milestone": "string",
"direction": "string",
"namePrefix": "string",
"additionalNamePrefix": "string",
"nameSuffix": "string",
"additionalNameSuffix": "string"
},
"companyPostalCode": "string",
"industrialZone": "string",
"building": "string",
"floor": "string",
"door": "string"
},
"alternativePostalAddress": {
"geographicCoordinates": {
"longitude": 0,
"latitude": 0,
"altitude": 0
},
"country": {
"technicalKey": "UNDEFINED",
"name": "string"
},
"administrativeAreaLevel1": {
"countryCode": "UNDEFINED",
"regionCode": "string",
"regionName": "string"
},
"postalCode": "string",
"city": "string",
"deliveryServiceType": "PO_BOX",
"deliveryServiceQualifier": "string",
"deliveryServiceNumber": "string"
},
"bpnLegalEntity": "string",
"bpnSite": "string",
"isCatenaXMemberData": true,
"createdAt": "2024-05-15",
"updatedAt": "2024-05-15",
"confidenceCriteria": {
"sharedByOwner": true,
"checkedByExternalDataSource": true,
"numberOfSharingMembers": 0,
"lastConfidenceCheckAt": "2024-05-15",
"nextConfidenceCheckAt": "2024-05-15",
"confidenceLevel": 0
},
"addressType": "LegalAndSiteMainAddress"
}
],
"errors": [
{
"errorCode": "AddressNotFound",
"message": "string",
"entityKey": "string"
}
],
"entityCount": 0,
"errorCount": 0
}
On malformed requests